通过 Webhook 接收数据库变更通知

Bytebase 是一款开源数据库工具，像 GitLab 管理代码一样，帮助 DBA 和开发者管理数据库 schema 的生命周期。

DBA 和开发者协同工作过程中，方便、灵活地获取数据库变更信息是关键，为此，Bytebase 支持用户在项目中配置 webhook ，可将 Bytebase 产生的数据库变更通知转发到配置的消息系统中。

可触发 webhook 发送消息的 5 类数据库变更事件是：

• 创建数据库变更工单(下文简称「工单」）

• 工单状态变更

• 工单中任务状态变更

• 工单信息变更

• 工单新增评论

支持的 2 种 webhook 是：

• 预置 webhook：可将 Bytebase 系统中产生的数据库变更通知直接发送到已支持的 IM 。已支持飞书、钉钉、企业微信、Slack、Discord 和 Teams。

• 自定义 webhook：可将 Bytebase 系统中产生的数据库变更通知发送到任意系统(例如内部自研运维平台)中进行二次消费。自定义 webhook 服务器需用户自行开发，其消息格式详见 Project Webhook (https://www.bytebase.com/docs/use-bytebase/webhook-integration/project-webhook#custom)。

在此，特别感谢社区小伙伴 @Cluas 贡献的 feat: add custom project webhook，帮 Bytebase 实现了 自定义 webhook 功能！

如何配置 webhook

三步即可完成配置，具体步骤如下：

1. 进入需配置 Webhook 的项目页面，点击 「Webhook」

2. 点击「添加 Webhook」，选择接收消息的服务，并填写「名称」和「Webhook url」(https://www.bytebase.com/docs/use-bytebase/webhook-integration/project-webhook#supported-webhook-endpoints)，下图以飞书为例

3. 选择发送消息的触发事件，并点击「创建」即可

当数据库变更发生时，飞书中就会收到通知，如下图所示